| Document type | Change document (design build vs. approved brief) |
| Baseline | Design Brief — Maintenance Management Platform v1.0 (08 Jul 2026), companion to SRS Draft v0.1 |
| Compared artefact | Interactive design build — Maintenance Platform.dc.html (with RequestBody and Chatter) |
| Version | 1.0 |
| Date | 10 July 2026 |
This document records where the current design build agrees with the Design Brief, where it intentionally deviates, and what remains open. It is organised by the brief's own screen inventory (S1–S13) and component list so every line traces back to a requirement. SRS requirement IDs are shown as FR-XX-00.
Status is expressed with these tokens:
Decisions taken after the brief was approved, and applied to the build.
| Area | Change | Reason | Status |
|---|---|---|---|
| Users | Each user now carries exactly one Discipline, chosen from a central list. Skill-tag (many-per-user) model dropped. | One user, one discipline | MODIFIED |
| Users & Teams | Teams reinstated. Screen is now a two-tab table (Users / Teams). Teams support create and delete. | Team creation requested | BUILT |
| Team membership | Many-to-many: a user can be in more than one team. Editable both ways — from a user (assign teams) and from a team (add / remove members). Restricted to Site Manager and Admin. | Stakeholder request | BUILT |
| Disciplines | Disciplines defined centrally under Tags, editable by Central Admin only. | Central definition | BUILT |
| Roles | Role set changed to Operations Lead (Central), Maintenance Lead (Central), Site Manager, Product Owner, Technical Lead. | Stakeholder request | MODIFIED |
| Access | Standalone Access screen/section removed. | Not required | DESCOPED |
| Maintenance Plan | "Preventive" renamed Maintenance Plan and moved under the Configure group. | Placement request | MODIFIED |
| Recurrence | PM recurrence reworked to Odoo style: Recurrent toggle, "Repeat every N Days/Weeks/Months/Years", Ends Forever / Until date. | Match Odoo pattern | BUILT |
| PM Plan form | Team made mandatory; Discipline added as optional selector. | Stakeholder request | BUILT |
| Activity create | Scheduled date added as a required field with a native date picker. | Emphasis on schedule date | BUILT |
| Activity detail | Scheduled date emphasised; Request date and Requested by demoted to secondary info. | Reviewer comment | BUILT |
| Detail layout | Split / Tabs switcher removed; detail is always the split (side-panel) layout. | Single layout | DESCOPED |
| Activity log | Follower avatars, Follow / Unfollow and the "followers" count removed from Chatter and the detail header. | Reviewer comment | DESCOPED |
| Site & Areas | Area delete is available only when no equipment is assigned to that area. | Data-integrity guard | BUILT |
Against the brief's screen inventory (Section 3).
| # | Screen | Status | Notes |
|---|---|---|---|
| S1 | Sign-in (SSO hand-off) | OPEN | No Keycloak hand-off screen built yet. NFR-SEC-01 |
| S2 | Dashboard | PARTIAL | Site dashboard with KPI strip and charts built. Portfolio and Central read-only variants not yet drawn. FR-RPT-01/02/03 |
| S3 | Requests board (Kanban) | BUILT | Board / List / Calendar toggle, stage columns, card badges, linked-pair icon. Labelled "Activities". FR-LC-01, FR-CAL-05 |
| S4 | Request detail | BUILT | Split record + activity log. Scheduled date emphasised. Followers removed (see §4). FR-CM-02, FR-LC-02/05 |
| S5 | Raise corrective request | BUILT | Guided create modal with equipment, problem, priority, immediate flag, team, scheduled date. FR-CM-01/04 |
| S6 | Maintenance calendar | BUILT | Month calendar of scheduled work with filter bar. FR-CAL-01 |
| S7 | Equipment register | BUILT | List filtered by area and tag. FR-EQ-04/09 |
| S8 | Equipment detail | BUILT | Overview / Reliability / History / Documents / Activity tabs. FR-EQ-02/06/07/10 |
| S9 | Preventive setup | MODIFIED | Built as "Maintenance Plan" under Configure; Odoo-style recurrence. FR-PM-01/02/03 |
| S10 | Reports & analytics | OPEN | Nav entry present; screen is a placeholder. Charts/export/scope not built. FR-RPT-04/05/06 |
| S11 | Site & area configuration | BUILT | Site details + area list; area delete guarded by equipment count. FR-SITE-01/07 |
| S12 | Users, teams & skills | MODIFIED | Built as "Users & Teams" (tabbed). Teams reinstated with many-to-many membership, editable both ways. Skill-tags replaced by one Discipline per user (see §4). FR-USR-01/04/06 |
| S13 | Stages configuration | BUILT | Ordered stage set with closing stage. FR-LC-08 |
Where the build intentionally departs from the approved brief. Each carries a requirement impact to confirm.
| Deviation | Brief said | Build does | Requirement impact |
|---|---|---|---|
| Skill tags → Discipline | Manage skill tags on engineers from a managed list; multiple per engineer. | One discipline per user, from a central list. | FR-USR-06 re-interpreted |
| Followers removed | Chatter shows follower avatars + follow / unfollow; following drives notifications. | Followers and follow controls removed. | FR-NOT-02 |
| Role set | Access matrix roles: Ops, Engineer, Site Mgr, Portfolio Mgr, Central, Admin. | Operations Lead, Maintenance Lead, Site Manager, Product Owner, Technical Lead. | §5, FR-ACC-01–06 |
| Access section | Role-based UI expressed by removing controls per role. | Standalone Access section removed; role gating retained in code. | FR-ACC-05 |
| PM placement | "Preventive" as a top-level operations screen. | "Maintenance Plan" under the Configure group. | Navigation only |
| Detail layout | Docked panel on desktop, switchable tab on mobile. | Split layout only; layout switcher removed. | Presentation only |
In the brief, not yet in the build.
| Item | What is missing | Requirement |
|---|---|---|
| Sign-in (SSO) | Branded Keycloak hand-off screen. | NFR-SEC-01 |
| Reports & analytics | KPI/chart screen with group-by, export and role scope. Currently a placeholder. | FR-RPT-04/05/06 |
| Dashboard variants | Portfolio (read-only roll-up) and Central (all-sites compare) dashboards. | FR-RPT-01/02 |
| Read-only role states | Portfolio / Central screens drawn without any write affordances. | FR-ACC-05 |
| Close-out detail | Confirm the pre-fill rule (elapsed candidates, discard ≤10 min, lowest) is fully represented. Modal exists. | FR-LC-10/11 |
| Empty / error states | Systematic empty, loading and no-access states across lists. | NFR-USE-01 |
Requirements whose status changed as a result of this cycle's decisions. All others remain as mapped in Brief Section 9.
| Requirement | Concerns | New status |
|---|---|---|
FR-USR-04 | Place users on teams | Met — many-to-many team membership |
FR-USR-06 | Skill tags on engineers | Replaced by single Discipline |
FR-LC-03 | Team assignment / shared visibility | Team model restored; confirm visibility rule |
FR-NOT-02 | Following controls who is notified | At risk — followers removed |
FR-ACC-01–06 | Role-based access model | Re-scoped — role set changed |
FR-LC-03). Removing followers still affects notification routing (FR-NOT-02) — decide whether notifications route by team / discipline / direct assignee, and update the SRS accordingly so traceability stays intact.
This change document is confirmed by:
| Role | Responsibility | Name / Sign-off |
|---|---|---|
| Operations Lead (Central) | Confirms operations workflows and cross-site oversight needs | — |
| Maintenance Lead (Central) | Confirms maintenance workflows, disciplines, and KPIs | — |
| Site Manager (representative) | Confirms site-level configuration and access model | — |
| Product Owner | Owns scope, priorities, and acceptance | — |
| Technical Lead | Confirms feasibility; owns the follow-on technical design | — |
End of change document v1.0 — companion to Design Brief v1.0 and SRS Draft v0.1